BBS Toolkit/BBS Toolkit.iso/doors_1/comline.zip/COMLINE.DOC

Text File | 1990-10-20 | 8KB | 163 lines

   Comline - Coml_Bat - ComDiag - Comline - Coml_Bat - ComDiag - Comline

                A command line parameter generator for use with
                SPITFIRE BBS Software V. 3.0

   Comline - Coml_Bat - ComDiag - Comline - Coml_Bat - ComDiag - Comline

   The Basics:

      Comline grew from a request by another Spitfire sysop for assistance
   in setting up a Door program for another type of BBS software which
   required passing several parameters normally found in the SFDOORS.DAT
   file on a command line; the door program not being able to read the
   information directly. Having had such a project myself on an earlier
   version of Spitfire, I had created a simple routine to read SFDOORS.DAT
   and compile the necessary command line to run the program. I decided to
   adapt this routine to a more universally compatable routine than the
   single use quick-and-dirty fix I had previously used, and Comline is the
   result. Comline reads the SFDOORS.DAT file, creates one additional and
   often required variable, and then reads and interprets a command line
   description created by the sysop to fit his needs. Comline interprets the
   parameter requirements, and prepares a command line with the appropriate
   variables and text.
      Three versions of the program have been included in this release;
   COMLINE.EXE, COML_BAT.EXE and COMDIAG.EXE. COMLINE.EXE is the simplest to
   use; create the command line description; copy comline, SFdoors.dat and
   the description (COMLINE.DAT) to the door program directory, and run
   COMLINE to start the door. Comline will remain in memory during the
   execution of the door, shelling to DOS to run the program. This does
   require approximately 105K of RAM to operate, however. While Spitfire
   releases all memory to the door programs, and this approach will allow
   99% of all doors I have encountered to operate, a second version of the
   program has been included for those with tighter memory constraints.
   COML_BAT.EXE performs exactly as described above for COMLINE.EXE, but
   instead of issuing the SHELL command and running the door itself; it
   creates a single line batch file, called SHELLINE.BAT, which contains
   the appropriate parameters. This file can be used with the CALL function
   to run the door, and uses no memory above that required for the door
   itself. BE CERTAIN TO USE "CALL" TO EXECUTE THIS FILE, as SF.BAT will
   transfer control to the SHELLINE.BAT file and not return to the BBS if
   you simply execute the SHELLINE.BAT file. The third version of the
   program, COMDIAG.EXE, simply prints out the command line as created to
   the screen, or to the printer if used as in COMDIAG > PRN:, for use in
   diagnosing errors or refining the COMLINE.DAT file.


   The Parameters:

      The COMLINE.DAT file should be built with a simple text editor,
   with no additional characters other than those needed in the command
   line or as variable descriptors. A simple example has been included in
   this collection to serve as test/learning material. The format of the
   line is simple, requiring nothing more than the text desired and the
   variables needed. The sample line reads as follows:

             OVERKILL @V4 @V33 @V7 @V5 @V6

   This line is interpreted as follows:

   OVERKILL - text passed on to the command line as typed.

   @V4   - Request to COMLINE to include variable #4, the user's first name

   @V33  - Request to COMLINE to include variable #33, the user's last name

   @V7   -    "    "  COMLINE "    "       "      #7,  user's remaining time

   @V5   -    "    "  COMLINE "    "       "      #5,  baud rate in use

   @V6   -    "    "  COMLINE "    "       "      #6,  Comm port in use


  The program searches the COMLINE.DAT file, and passes any characters not
  identified as variable requests directly on to the command line, and
  replaces the @V# with the appropriate values read from the SFDOORS.DAT
  file. The parameters are numbered exactly as they are found in the
  SPITFIRE manual, page 111, description of the SFDOORS.DAT file. The single
  exception to this layout is variable #33. Many doors ask for the user's
  last name, and will not accept spaces in the name fields. Variable #33 is
  taken from the user's full name in the SFDOORS.DAT file, variable #2, and
  is essentially everything from the first space (dividing the first and
  last names in most cases) to the end of the field, with any further spaces
  replaced with underscore ( _ ) characters to allow for last names with
  two segments like "Von Frankenstein", which would be rendered as
  VON_FRANKENSTEIN. The order of the items should be exactly as required by
  the program to be run, and all variable descriptors (@V#) MUST be entered
  exactly as shown, with an uppercase V and no spaces between the @V and the
  number.

  Variable List:
  (for those of us too disorganized to find our manuals just now, like me!)

         Information taken from SFDORS.DAT

  @V1  - User Number (record number in SFUSERS.DAT)
  @V2  - User's Full Name
  @V3  - User's Password
  @V4  - Users First Name only
  @V5  - Baud Rate of this call
  @V6  - Comm Port
  @V7  - Time left on this call
  @V8  - # seconds since midnight when entering door
  @V9  - Path to Spitfire command files (C:\SF, etc)
  @V10 - ANSI on, TRUE if ansi set on, FALSE if ansi set off
  @V11 - Security level
  @V12 - # of Uploads
  @V13 - # of Downloads
  @V14 - Total time allowed this call
  @V15 - # seconds since midnight when caller logged on
  @V16 - # seconds caller has gained since logged on
  @V17 - Sysop next? TRUE if sysop next set, FALSE if not set
  @V18 - Front End? TRUE if BBS entered through Front-end program
  @V19 - DTE Unlocked - TRUE if DTE not locked, FALSE if DTE Locked (HST)
  @V20 - Max Baud rate for BBS
  @V21 - Error Correction Connection? TRUE if MNP/ARQ, FALSE if non MNP
  @V22 - Last Message Conference selected
  @V23 - Last File area selected
  @V24 - Node Number for this caller
  @V25 - Downloads allowed per day
  @V26 - Files downloaded by this caller today
  @V27 - Total Bytes allowed to download per day
  @V28 - Bytes downloaded by this caller today
  @V29 - Total K uploaded by this caller
  @V30 - Total K downloaded by this caller
  @V31 - Caller's phone number
  @V32 - Caller's City and State

         Information created by COMLINE from SFDOORS.DAT

  @V33 - Caller's Last name, with any spaces replaced by _ characters


  These variables can be used in any order or in any combination on the
  command line, as many times as required by the program, to a maximum
  limitation of 255 characters in the final line created by the COMLINE
  program.

   The Legalese:

   This program is released as freeware, fully owned and all rights reserved
   by Butterhoofs' Enterprises. Unlimited license to use this software is
   granted to all registered Spitfire sysops; all others are encouraged to
   register Spitfire at their earliest opportunity if they utilize it, and
   are granted a 30 day period in which to evaluate this software for use
   in their application. No funds are requested of any person, though
   registered versions of other Spitfire utilities would be gratefully
   accepted from their authors if they are so inclined and find this
   program useful. Source code for turbo basic is included, and may be
   incorporated into other products with the prior written or verbal
   permission of the author, Michael Martell, or any officer of
   Butterhoofs' Enterprises. No warranty as to fitness for any purpose or
   application is expressed or implied; and liability under any claim
   will be limited in whole to the purchase price of this software.
   The standard Missouri Guarantee is included: if it breaks, you get to
   keep both halves. The author will provide unlimited telephone or
   message support at the user's request, either by calling the WOLF'S MOON
   BBS at [phone] (19200 HST) or voice at [phone], 6:00 to
   11:00 PM Eastern Standard Time. Customized versions for specific purposes
   may be requested of the author, for minimal or no fees depending on the
   complexity of the request and the hectic nature of the author's schedule
   at the time requested.